Skip to content

docs: rebuild documentation for Solid 2 - #1626

Closed
ryansolid wants to merge 48 commits into
mainfrom
v2-rebuild
Closed

docs: rebuild documentation for Solid 2#1626
ryansolid wants to merge 48 commits into
mainfrom
v2-rebuild

Conversation

@ryansolid

Copy link
Copy Markdown
Member

Summary

  • replace the versioned preview area with a unified Solid documentation structure covering core concepts, application development, routing, guides, and migrations
  • add curated reference documentation across Solid, the web renderer, Router, Meta, Vite integration, and filesystem routing, including LLM-friendly indexes
  • add publication safeguards, generated-reference tooling, search updates, and a React mental-model migration guide

Test plan

  • pnpm check:types
  • pnpm check:lint
  • pnpm exec prettier . --check
  • pnpm lint:tone (0 errors; 11 existing generated-reference warnings)
  • pnpm build
  • Internal link and anchor crawl (150 links)

Made with Cursor

ryansolid and others added 30 commits August 10, 2026 14:08
Co-authored-by: Cursor <cursoragent@cursor.com>
Implements the rebuild proposal: single-version site with the new IA
(getting-started, concepts, building-apps, routing, guides, migration,
reference by package). Moves the generated v2 reference under
reference/solid-js and reference/solid-web, relocates the Meta 1.0 docs,
adds planned-page stubs, and removes the per-project version routing,
project tabs, and legacy redirect middleware.

Co-authored-by: Cursor <cursoragent@cursor.com>
Points extract-solid-ref.mjs at src/routes/reference with solid-js and
solid-web groups, makes cleanup respect hand-written pages, regenerates
against the current next SHA (adds affects, clientOnly, httpStatus,
httpHeader; hides the host-integration surface pending its own section;
drops the removed renderToStringAsync).

Co-authored-by: Cursor <cursoragent@cursor.com>
WRITING.md gains a section for AI-drafted content: claims traceable to
source, banned filler and marketing words, no history-relative framing
outside migration guides. scripts/lint-tone.mjs enforces the mechanical
parts over src/routes mdx (errors for hand-written pages, warnings for
generated ones) and runs in the static checks workflow.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Curate the generated llms.txt index and provide a matching single-file corpus for tools that cannot follow per-page links.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Explain the source-backed component, JSX, rendering, SSR, and hydration behavior needed to replace the planned concept stubs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document commit-zero SSR and hydration behavior from the final Solid 2.0 source, and remove mismatched dynamic API reference links.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned stubs with source-traced guidance for async state, mutation coordination, and boundary ownership.

Co-authored-by: Cursor <cursoragent@cursor.com>
Explain how loading values provide first-flight content without boundary or pending state, including hydration and retry behavior.

Co-authored-by: Cursor <cursoragent@cursor.com>
Lead with normal loading, stale-content, error, and reveal patterns while keeping committed first values as an advanced option.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document start-mode structure, Vite styling and assets, and typed environment boundaries from the current plugin and templates.

Co-authored-by: Cursor <cursoragent@cursor.com>
Narrow app shell behavior to verified plugin contracts and maintained template examples, including entry precedence, CSS delivery, and environment security boundaries.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned pages with source-backed guidance for server functions, sessions, middleware, API routes, and deployment.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Explain router-neutral request and single-flight contracts, then map the supported TanStack Router and Query template onto them.

Co-authored-by: Cursor <cursoragent@cursor.com>
Ground request, single-flight, and TanStack hydration statements in the current plugin, runtime, router, and template implementations.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document the Router 2 task flow and public package surface from the pinned local source so application and integration behavior can be reviewed independently of migration material.

Co-authored-by: Cursor <cursoragent@cursor.com>
ryansolid and others added 18 commits August 10, 2026 23:31
Remove publication-only source notes and tighten the Router guides for direct, scannable task guidance while preserving immutable reference provenance.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document the source-backed vite-plugin-solid and filesystem-routing public APIs, options, generated modules, and output contracts.

Co-authored-by: Cursor <cursoragent@cursor.com>
Align source metadata and sidebar ordering with reference conventions while tightening prose and preserving public route slugs.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document the verified upgrade order and behavioral changes so applications can migrate the core runtime without relying on inferred API renames.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Document the separate SolidStart 1 and 2 extraction paths so applications move onto the verified start-mode runtime without implying an in-place upgrade.

Co-authored-by: Cursor <cursoragent@cursor.com>
Avoid the unsupported automatic step components so the guide prerenders and hydrates correctly.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned stub with a source-pinned, incremental path from the shipped component and data APIs to createRouter.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep reviewer provenance in the handoff while leaving the published migration page focused on user-facing behavior.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Avoid the unsupported automatic step components so the guide prerenders and hydrates correctly.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document the maintained client, browser, and server test postures with verified examples and cleanup guidance.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep jsdom in browser-mode installs so Vitest exits cleanly, and describe Solid 2 staged writes accurately.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep the merged guides formatter-clean and align the sidebar transform with SolidBase's metadata-aware type.

Co-authored-by: Cursor <cursoragent@cursor.com>
Improve safety, teaching order, migrations, and package-owned references before the Solid 2 release.

Co-authored-by: Cursor <cursoragent@cursor.com>
Polish async and JSX guidance, curate generated references, and add staging safeguards so the rebuilt documentation can be reviewed safely before launch.

Co-authored-by: Cursor <cursoragent@cursor.com>
* docs: apply Solid 2 RC follow-ups

* docs: remove component migration notes
Give React users and tooling a neutral semantic crosswalk so migrations follow Solid's execution, async, and composition models instead of translating APIs mechanically.

Co-authored-by: Cursor <cursoragent@cursor.com>
@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 6264079
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/6a7bff206ce4070008211531
😎 Deploy Preview https://deploy-preview-1626--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploy Preview for solid-docs-v2 ready!

Name Link
🔨 Latest commit 6264079
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs-v2/deploys/6a7bff2007cf4900085d7ab7
😎 Deploy Preview https://deploy-preview-1626--solid-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@ryansolid

Copy link
Copy Markdown
Member Author

Closing this PR: v2-rebuild remains an independent branch and is not intended to merge into main.

@ryansolid ryansolid closed this Aug 12, 2026
@ryansolid

Copy link
Copy Markdown
Member Author

For clarity: this PR was opened by the coding agent after it misinterpreted an instruction to “rebase and merge.” Ryan did not intend to merge v2-rebuild into main; the branch is intentionally independent. The mistake was entirely the agent's, and the PR was closed as soon as Ryan corrected it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants